Skip to main content
GET
Get billing policy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
agent_slug
string
required

Response

id
string
required

Unique Hyperline identifier for this resource.

Example:

"d18603dd-7285-4bf5-a45e-88d7de8f37c9"

customer_id
string
required

Hyperline customer identifier.

Example:

"cus_example"

agent_slug
string | null
required

Agent scope identifier. Null is the customer's shared pool.

Example:

"support"

is_default
boolean
required

Whether this is the default plan or shared customer scope.

Example:

false

mode
enum<string>
required

Billing mode.

  • wallet: Charges a monetary wallet.
  • credits: Consumes a credit balance.
  • windows: Meters weighted units against rolling allowances.
Available options:
wallet,
credits,
windows
Example:

"wallet"

wallet_id
string | null
required

Customer wallet identifier. Omit on wallet policy writes to provision or reuse the customer's wallet.

Example:

"wal_example"

credit_product_id
string | null
required

Public credit product identifier whose balance this policy consumes.

Example:

"prd_credits"

markup_percent
string
required

Percentage added to resolved cost. Null on writes means no override; an attached plan may supply the value.

Pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
Example:

"20"

overage_mode
enum<string>
required

Behavior when credits or an allowance are exhausted. Policy values may inherit the attached plan.

  • refuse: Rejects the call that crosses the boundary without deducting usage.
  • metered: Prices the whole call as monetary overage, using the overage card or USD provider cost plus markup.
Available options:
refuse,
metered
Example:

"metered"

overage_markup_percent
string
required

Percentage added to provider cost for overage. Mutually exclusive with overage_rate_card_id.

Pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
Example:

"10"

overage_rate_card_id
string | null
required

Currency rate card used to price overage directly. Null means provider cost plus the resolved overage markup.

Example:

"airc_overage"

overage_rate_card_source
enum<string> | null
required

Source of the effective overage rate card. Null when no card is configured.

  • policy: Selected directly on the customer policy.
  • plan: Inherited from the attached plan.
Available options:
policy,
plan
Example:

"plan"

overage_wallet_id
string | null
required

Wallet charged for overage. Null bills overage in arrears.

Example:

"wal_example"

floor
string
required

Minimum available balance a spend check requires, in the policy's denomination.

Pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
Example:

"0"

windows
object[]
required

Rolling allowances. Required for windows plans; each window meters every call. A plan replacement replaces the entire array.

Example:
rate_card_id
string | null
required

Rate card reference. On policy writes, omission preserves the current reference and null detaches it; on plan replacement omission clears it.

Example:

"airc_example"

rate_card_source
enum<string> | null
required

Source of the effective rate card. Null when no card is configured.

  • policy: Selected directly on the customer policy.
  • plan: Inherited from the attached plan.
Available options:
policy,
plan
Example:

"policy"

plan_id
string | null
required

Billing plan reference. On policy writes, omission preserves the current plan and null detaches it.

Example:

"aiplan_example"

settlement_interval_minutes
number | null
required

Settlement interval in minutes. Null means no interval override. Mutually exclusive with settlement_schedule.

Example:

60

settlement_schedule
enum<string> | null
required

Calendar settlement schedule. Null clears the override; mutually exclusive with settlement_interval_minutes.

  • calendar_month: Settles at the end of each UTC calendar month.
Available options:
calendar_month
Example:

"calendar_month"

resolved_rate_card
object | null
required

Summary of the effective pricing after applying rate-card inheritance. Null when no card resolves.

Example:
overrides
object
required

Pricing, window and settlement overrides before plan inheritance; null means no override. Use these values when editing configuration.

Example:
effective_settlement_interval_minutes
number | null
required

Settlement interval after plan inheritance.

Example:

60

effective_settlement_schedule
enum<string> | null
required

Settlement schedule after plan inheritance.

Available options:
calendar_month
Example:

null

blocked
boolean
required

Whether spending is disabled for this billing scope.

Example:

false

created_at
string<date-time>
required

Creation time as a UTC ISO 8601 timestamp.

Example:

"2026-09-01T00:00:00Z"

updated_at
string<date-time>
required

Last update time as a UTC ISO 8601 timestamp.

Example:

"2026-09-02T12:00:00Z"